Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a "Write your first test" page to the Get Started section #1777

Merged
merged 5 commits into from
Dec 4, 2024

Conversation

oleiade
Copy link
Member

@oleiade oleiade commented Oct 14, 2024

What?

As we agreed during our latest meetup, this PR adds a "Write your first test" page to the Getting Started section.

It aims to cover a gap between installing k6, and "Running k6", as we realised we had not introduced users to scripting in the logical flow yet. This PR aims to bridge that gap, and links to a lot of useful resources users might find useful on their onboarding experience with k6.

@heitortsergent this is really a draft on my side, you should feel free to propose whatever you see fit 👍🏻 Also, I've noticed we have some pages in our documentation which might repeat this information, we might want to also reorganize/regroup it somehow 🙇🏻

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/next folder of the documentation.

@oleiade oleiade added the Area: OSS Content Improvements or additions to community/oss documentation label Oct 14, 2024
@oleiade oleiade self-assigned this Oct 14, 2024
@oleiade
Copy link
Member Author

oleiade commented Nov 4, 2024

🏓 @heitortsergent I've addressed some of the feedback you offered last time we spoke 🙇🏻

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the delay @oleiade! I finally got around to reviewing the changes you've made, I left a few comments with some edits, and some style guide changes. Let me know what you think, I think this new guide looks good!

docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
docs/sources/next/get-started/write-your-first-test.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the changes @oleiade. 🙇

@oleiade oleiade merged commit 48a9a43 into main Dec 4, 2024
3 checks passed
@oleiade oleiade deleted the get_started/write_your_first_test branch December 4, 2024 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OSS Content Improvements or additions to community/oss documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants